[GI] Fixes of existing incorrect annotations
authorPavel Holejsovsky <pholejs@src.gnome.org>
Tue, 18 Jan 2011 09:14:33 +0000 (10:14 +0100)
committerPavel Holejsovsky <pholejs@src.gnome.org>
Thu, 20 Jan 2011 12:56:06 +0000 (13:56 +0100)
19 files changed:
gdk/gdkdevice.c
gdk/gdkkeys.c
gdk/gdkvisual.c
gtk/gtkaction.c
gtk/gtkcellrenderer.c
gtk/gtkfilechooser.c
gtk/gtkicontheme.c
gtk/gtkiconview.c
gtk/gtkmain.c
gtk/gtkradiobutton.c
gtk/gtkradiomenuitem.c
gtk/gtkradiotoolbutton.c
gtk/gtkselection.c
gtk/gtkstylecontext.c
gtk/gtkthemingengine.c
gtk/gtktreemodel.c
gtk/gtktreeview.c
gtk/gtkwidget.c
gtk/gtkwidgetpath.c

index e6ee01d5dd77d8cfea57ca04693255afe01283ff..a9119233c0748cf222aa466f5b2fd8d4d5e6667c 100644 (file)
@@ -498,7 +498,7 @@ gdk_device_get_window_at_position (GdkDevice  *device,
  * @window: the window with respect to which which the event coordinates will be reported
  * @start: starting timestamp for range of events to return
  * @stop: ending timestamp for the range of events to return
- * @events: (array length=n_events) (out) (transfer none): location to store a newly-allocated array of #GdkTimeCoord, or %NULL
+ * @events: (array length=n_events) (out) (transfer full): location to store a newly-allocated array of #GdkTimeCoord, or %NULL
  * @n_events: location to store the length of @events, or %NULL
  *
  * Obtains the motion history for a pointer device; given a starting and
@@ -554,8 +554,8 @@ _gdk_device_allocate_history (GdkDevice *device,
 }
 
 /**
- * gdk_device_free_history:
- * @events: (inout) (transfer none): an array of #GdkTimeCoord.
+ * gdk_device_free_history: (skip)
+ * @events: an array of #GdkTimeCoord.
  * @n_events: the length of the array.
  *
  * Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().
index 74993d6c2035dad9e651634e57e547f4ed1af54a..59f8784802630397932220b1103df2ca57d580d4 100644 (file)
@@ -366,8 +366,9 @@ gdk_keymap_get_num_lock_state (GdkKeymap *keymap)
  * gdk_keymap_get_entries_for_keyval:
  * @keymap: a #GdkKeymap
  * @keyval: a keyval, such as %GDK_a, %GDK_Up, %GDK_Return, etc.
- * @keys: (out): return location for an array of #GdkKeymapKey
- * @n_keys: (out): return location for number of elements in returned array
+ * @keys: (out) (array length=n_keys) (transfer full): return location
+ *     for an array of #GdkKeymapKey
+ * @n_keys: return location for number of elements in returned array
  *
  * Obtains a list of keycode/group/level combinations that will
  * generate @keyval. Groups and levels are two kinds of keyboard mode;
index c1b0160f2e8e2ff49d4f320cf0be558b71f89fec..4a25402313919ad6193408d0926a462f98d3f9c6 100644 (file)
@@ -219,8 +219,9 @@ gdk_visual_get_best_with_both (gint          depth,
 
 /**
  * gdk_query_depths:
- * @depths: (out) (array): return location for available depths
- * @count: (out): return location for number of available depths
+ * @depths: (out) (array length=count) (transfer none): return
+ *     location for available depths
+ * @count: return location for number of available depths
  *
  * This function returns the available bit depths for the default
  * screen. It's equivalent to listing the visuals
index c9a644107f97b133a81c33edfe131665fd1622a2..002a352a3d42b47045e4b8448771e3e02af5ceeb 100644 (file)
@@ -874,7 +874,7 @@ gtk_action_unblock_activate (GtkAction *action)
  * This function is intended for use by action implementations to
  * create icons displayed in the proxy widgets.
  *
- * Returns: (transfer full): a widget that displays the icon for this action.
+ * Returns: (transfer none): a widget that displays the icon for this action.
  *
  * Since: 2.4
  */
@@ -900,7 +900,7 @@ gtk_action_create_icon (GtkAction *action, GtkIconSize icon_size)
  *
  * Creates a menu item widget that proxies for the given action.
  *
- * Returns: (transfer full): a menu item connected to the action.
+ * Returns: (transfer none): a menu item connected to the action.
  *
  * Since: 2.4
  */
@@ -925,7 +925,7 @@ gtk_action_create_menu_item (GtkAction *action)
  *
  * Creates a toolbar item widget that proxies for the given action.
  *
- * Returns: (transfer full): a toolbar item connected to the action.
+ * Returns: (transfer none): a toolbar item connected to the action.
  *
  * Since: 2.4
  */
@@ -1812,7 +1812,8 @@ gtk_action_disconnect_accelerator (GtkAction *action)
  * item or the toolbar item it creates, this function returns an
  * instance of that menu.
  *
- * Return value: (transfer full): the menu item provided by the action, or %NULL.
+ * Return value: (transfer none): the menu item provided by the
+ *               action, or %NULL.
  *
  * Since: 2.12
  */
index b5e738a08ccb27604adae95f2eb12c036f8d9d65..36a6120dc8a04e9f4095a109c4ed886df0a22e02 100644 (file)
@@ -772,7 +772,7 @@ gtk_cell_renderer_activate (GtkCellRenderer      *cell,
  *
  * Passes an activate event to the cell renderer for possible processing.
  *
- * Return value: (transfer full): A new #GtkCellEditable, or %NULL
+ * Return value: (transfer none): A new #GtkCellEditable, or %NULL
  **/
 GtkCellEditable *
 gtk_cell_renderer_start_editing (GtkCellRenderer      *cell,
index da9d7c5e942b6474db2d48db321faf11b5474375..9243612469e23cf14996fb83718bd46f663a9329 100644 (file)
@@ -1698,9 +1698,10 @@ gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
  * Lists all the selected files and subfolders in the current folder of @chooser
  * as #GFile. An internal function, see gtk_file_chooser_get_uris().
  *
- * Return value: (element-type utf8) (transfer full): a #GSList containing a #GFile for each selected
- *   file and subfolder in the current folder.  Free the returned list
- *   with g_slist_free(), and the files with g_object_unref().
+ * Return value: (element-type GFile) (transfer full): a #GSList
+ *   containing a #GFile for each selected file and subfolder in the
+ *   current folder.  Free the returned list with g_slist_free(), and
+ *   the files with g_object_unref().
  *
  * Since: 2.14
  **/
@@ -1988,7 +1989,7 @@ gtk_file_chooser_get_use_preview_label (GtkFileChooser *chooser)
  * Gets the #GFile that should be previewed in a custom preview
  * Internal function, see gtk_file_chooser_get_preview_uri().
  *
- * Return value: (transfer none): the #GFile for the file to preview,
+ * Return value: (transfer full): the #GFile for the file to preview,
  *     or %NULL if no file is selected. Free with g_object_unref().
  *
  * Since: 2.14
@@ -2208,10 +2209,10 @@ gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
  * Lists the current set of user-selectable filters; see
  * gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
  *
- * Return value: (element-type utf8) (transfer container): a #GSList containing the current set of
- *  user selectable filters. The contents of the list are
- *  owned by GTK+, but you must free the list itself with
- *  g_slist_free() when you are done with it.
+ * Return value: (element-type GtkFileFilter) (transfer container): a
+ *  #GSList containing the current set of user selectable filters. The
+ *  contents of the list are owned by GTK+, but you must free the list
+ *  itself with g_slist_free() when you are done with it.
  *
  * Since: 2.4
  **/
index 705cc122f72f869222f8749e216aa188b7ad502b..62b842982c90cf61fa8e3c7c2ec4a0fe9279bd82 100644 (file)
@@ -1731,10 +1731,10 @@ add_key_to_list (gpointer  key,
  * but will typically include such values as "Applications" and
  * "MimeTypes".
  *
- * Return value: (element-type utf8) (transfer none): a #GList list holding the names of all the
- *  icons in the theme. You must first free each element
- *  in the list with g_free(), then free the list itself
- *  with g_list_free().
+ * Return value: (element-type utf8) (transfer full): a #GList list
+ *  holding the names of all the icons in the theme. You must first
+ *  free each element in the list with g_free(), then free the list
+ *  itself with g_list_free().
  *
  * Since: 2.4
  **/
index 9f89851cf38bb3d131b83ad6c99f226f4be06918..ee9be8bd74880092d814cf3a8076185be24d3295 100644 (file)
@@ -6816,7 +6816,7 @@ gtk_icon_view_get_dest_item_at_pos (GtkIconView              *icon_view,
  * Creates a #cairo_surface_t representation of the item at @path.  
  * This image is used for a drag icon.
  *
- * Return value: (transfer full) a newly-allocated surface of the drag icon.
+ * Return value: (transfer full): a newly-allocated surface of the drag icon.
  * 
  * Since: 2.8
  **/
index 799db279358bcc696833ac95ad6b4cb041ef7845..ae6980f090d8582eb2de35d87b84d5e4b3790bd1 100644 (file)
@@ -1036,7 +1036,8 @@ gtk_init_with_args (gint                 *argc,
 /**
  * gtk_parse_args:
  * @argc: (inout): a pointer to the number of command line arguments
- * @argv: (array) (inout): a pointer to the array of command line arguments
+ * @argv: (array length=argc) (inout): a pointer to the array of
+ *     command line arguments
  *
  * Parses command line arguments, and initializes global
  * attributes of GTK+, but does not actually open a connection
index b6546ffaa0f0559bdd7e4b71bb27272c43499d51..75fa843348b562084f4850752a4bc55202e12834 100644 (file)
@@ -488,7 +488,7 @@ gtk_radio_button_new_with_mnemonic (GSList      *group,
  * @radio_group_member. As with gtk_radio_button_new(), a widget
  * should be packed into the radio button.
  *
- * Returns: (transfer full): a new radio button.
+ * Returns: (transfer none): a new radio button.
  */
 GtkWidget*
 gtk_radio_button_new_from_widget (GtkRadioButton *radio_group_member)
@@ -529,7 +529,7 @@ gtk_radio_button_new_with_label_from_widget (GtkRadioButton *radio_group_member,
  * will be created using gtk_label_new_with_mnemonic(), so underscores
  * in @label indicate the mnemonic for the button.
  *
- * Returns: (transfer full): a new #GtkRadioButton
+ * Returns: (transfer none): a new #GtkRadioButton
  **/
 GtkWidget*
 gtk_radio_button_new_with_mnemonic_from_widget (GtkRadioButton *radio_group_member,
index 78cfea7398d2046c02d33a3d9e7f182ed7191800..8da604d5d3cd43d1bed7428c4e413ee88900de96 100644 (file)
@@ -251,7 +251,7 @@ gtk_radio_menu_item_new_with_mnemonic (GSList *group,
  *
  * Creates a new #GtkRadioMenuItem adding it to the same group as @group.
  *
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
  *
  * Since: 2.4
  **/
@@ -280,7 +280,7 @@ gtk_radio_menu_item_new_from_widget (GtkRadioMenuItem *group)
  *
  * The new #GtkRadioMenuItem is added to the same group as @group.
  *
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
  *
  * Since: 2.4
  **/
@@ -306,7 +306,7 @@ gtk_radio_menu_item_new_with_mnemonic_from_widget (GtkRadioMenuItem *group,
  * Creates a new GtkRadioMenuItem whose child is a simple GtkLabel.
  * The new #GtkRadioMenuItem is added to the same group as @group.
  *
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
  *
  * Since: 2.4
  **/
index 9a37c182717295a27ef7f583672344669d6776b2..6ca58532eb98e1e2ba396e886a533170a1733610 100644 (file)
@@ -167,7 +167,7 @@ gtk_radio_tool_button_new_from_stock (GSList      *group,
  *
  * Creates a new #GtkRadioToolButton adding it to the same group as @gruup
  *
- * Return value: (transfer full): The new #GtkRadioToolButton
+ * Return value: (transfer none): The new #GtkRadioToolButton
  *
  * Since: 2.4
  **/
@@ -193,7 +193,7 @@ gtk_radio_tool_button_new_from_widget (GtkRadioToolButton *group)
  * The new #GtkRadioToolButton will contain an icon and label from the
  * stock item indicated by @stock_id.
  *
- * Return value: (transfer full): A new #GtkRadioToolButton
+ * Return value: (transfer none): A new #GtkRadioToolButton
  *
  * Since: 2.4
  **/
index 2385c969a36212e730b350a3d717da78cc7a5c66..9665a9848b08ce176df04b25d46c1be2b846a5fd 100644 (file)
@@ -1294,7 +1294,7 @@ gtk_selection_data_get_display (const GtkSelectionData *selection_data)
  * @selection_data: a pointer to a #GtkSelectionData structure.
  * @type: the type of selection data
  * @format: format (number of bits in a unit)
- * @data: (array) (element-type guchar): pointer to the data (will be copied)
+ * @data: (array length=length): pointer to the data (will be copied)
  * @length: length of the data
  * 
  * Stores new data into a #GtkSelectionData object. Should
index 0f30fcd3a17ee2398fc2d296eeb875bb7a7f5d4b..4af7a2aa632d1f7494fc747b6657d2222ec2be3b 100644 (file)
@@ -2387,7 +2387,7 @@ _gtk_style_context_peek_style_property (GtkStyleContext *context,
  * gtk_style_context_get_style_property:
  * @context: a #GtkStyleContext
  * @property_name: the name of the widget style property
- * @value: (out) (transfer full): Return location for the property value
+ * @value: Return location for the property value
  *
  * Gets the value for a widget style property.
  *
index 80b02b0e6b5ca65cf9b0f4beeb0323d2fb97c6f4..5d406c2b0c5ee1a31cad6e42dd12a71e15522a18 100644 (file)
@@ -473,7 +473,7 @@ gtk_theming_engine_get (GtkThemingEngine *engine,
  * gtk_theming_engine_get_style_property:
  * @engine: a #GtkThemingEngine
  * @property_name: the name of the widget style property
- * @value: (out) (transfer full): Return location for the property value, free with
+ * @value: Return location for the property value, free with
  *         g_value_unset() after use.
  *
  * Gets the value for a widget style property.
index d99067623b037d03b7b9990f8b141dcc7d09ede5..67310d68c4f962db4dd366094ebcca9c90bef1e9 100644 (file)
@@ -1404,7 +1404,7 @@ gtk_tree_model_iter_previous_default (GtkTreeModel *tree_model,
 /**
  * gtk_tree_model_iter_previous:
  * @tree_model: a #GtkTreeModel
- * @iter: (inout): the #GtkTreeIter
+ * @iter: (in): the #GtkTreeIter
  *
  * Sets @iter to point to the previous node at the current level.
  *
index d0311b4aa172074b2b73fc2d778baf185a980e08..b3f6c6fc8392ba565545380e9f867f04ed7726f6 100644 (file)
@@ -14193,7 +14193,8 @@ gtk_tree_view_enable_model_drag_source (GtkTreeView              *tree_view,
 /**
  * gtk_tree_view_enable_model_drag_dest:
  * @tree_view: a #GtkTreeView
- * @targets: (array): the table of targets that the drag will support
+ * @targets: (array length=n_targets): the table of targets that
+ *           the drag will support
  * @n_targets: the number of items in @targets
  * @actions: the bitmask of possible actions for a drag from this
  *    widget
index 40ec6040a85cc0bcae9fc0aeafed94c324c556fa..cd408cc7b97f695700c94f3ccdd37003f3fcf806 100644 (file)
@@ -4719,7 +4719,7 @@ gtk_widget_queue_shallow_draw (GtkWidget *widget)
 /**
  * gtk_widget_size_allocate:
  * @widget: a #GtkWidget
- * @allocation: (inout): position and size to be allocated to @widget
+ * @allocation: position and size to be allocated to @widget
  *
  * This function is only used by #GtkContainer subclasses, to assign a size
  * and position to their child widgets.
index f0ae30ea146faea533b9450f3ed5d47afdce0f6d..40f1cac16b9e060ef712118bb243d8cd045cbcc6 100644 (file)
@@ -599,9 +599,9 @@ gtk_widget_path_iter_clear_classes (GtkWidgetPath *path,
  * Returns a list with all the class names defined for the widget
  * at position @pos in the hierarchy defined in @path.
  *
- * Returns: (transfer container) (type utf8): The list of classes,
- *          This is a list of strings, the #GSList contents are
- *          owned by GTK+, but you should use g_slist_free() to
+ * Returns: (transfer container) (element-type utf8): The list of
+ *          classes, This is a list of strings, the #GSList contents
+ *          are owned by GTK+, but you should use g_slist_free() to
  *          free the list itself.
  *
  * Since: 3.0
@@ -836,9 +836,9 @@ gtk_widget_path_iter_clear_regions (GtkWidgetPath *path,
  * Returns a list with all the region names defined for the widget
  * at position @pos in the hierarchy defined in @path.
  *
- * Returns: (transfer container) (type utf8): The list of regions,
- *          This is a list of strings, the #GSList contents are
- *          owned by GTK+, but you should use g_slist_free() to
+ * Returns: (transfer container) (element-type utf8): The list of
+ *          regions, This is a list of strings, the #GSList contents
+ *          are owned by GTK+, but you should use g_slist_free() to
  *          free the list itself.
  *
  * Since: 3.0